/*
 * Copyright (c) 1998-2011 Caucho Technology -- all rights reserved
 *
 * This file is part of Resin(R) Open Source
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Resin Open Source is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Resin Open Source is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Resin Open Source; if not, write to the
 *   Free SoftwareFoundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package javax.resource.cci;

import javax.resource.Referenceable;
import javax.resource.ResourceException;
import java.io.Serializable;

/**
 * Creates application connection objects.  Generally the ConnectionFactory
 * will be stored in JNDI.
 */
public interface ConnectionFactory extends Serializable, Referenceable {
  /**
   * Returns an application connection.
   *
   * @return the application's connection facade
   */
  public Connection getConnection()
    throws ResourceException;

  /**
   * Gets a connection with given properties.
   *
   * @param properties the properties of the connection
   */
  public Connection getConnection(ConnectionSpec properties)
    throws ResourceException;

  /**
   * Return a RecordFactory which creates generic Record instances.
   */
  public RecordFactory getRecordFactory()
    throws ResourceException;

  /**
   * Returns the metadata for the resource adapter.
   */
  public ResourceAdapterMetaData getMetaData()
    throws ResourceException;
}
